Package com.cisco.pt.ipc.system.impl
Class VariableImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.VariableImpl
Information provided by the PKI file:
\class Variable
\brief Variable is the base class for variables in the VariableManager.
\example appWindow().getActiveFile().getVariableManager().getVariable(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionVariableImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptiongetPool()Information provided by the PKI file:getType()Information provided by the PKI file:booleanInformation provided by the PKI file:name()Information provided by the PKI file:valueOfIndex(int index) Information provided by the PKI file:Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
VariableImpl
public VariableImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
name
Information provided by the PKI file:
\brief Returns the name of the variable. \return QString, the name of the variable. -
valueToString
Information provided by the PKI file:
\brief Returns the value of the variable. \return QString, the value of the variable.- Specified by:
valueToStringin interfaceVariable- Returns:
- String Returns a String
-
valueOfIndex
Information provided by the PKI file:
\brief Returns the value of the variable at the specified index. \param index, the index of the variable of interest. \return QString, the value of the variable.- Specified by:
valueOfIndexin interfaceVariable- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
getPool
Information provided by the PKI file:
\brief Returns the pool that this variable is associated with. \return Pool, the Pool object that this variable is associated with. -
isInPool
Information provided by the PKI file:
\brief Returns true if the specified value is in the pool, otherwise false. \param value, the value of interest. \return bool, true if the specified value is in the pool, otherwise false. -
getType
Information provided by the PKI file:
\brief Returns the type of the variable. \return VARIABLETYPE, the type of the variable. Variable types: ENTIRE_RANGE = 0, RANDOM = 1, STATIC = 2, SEED = 3
-